/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.server.dao;

import com.niiuzu.server.dao.exception.DaoException;
import com.niiuzu.shared.model.User;

/**
 * Gestionnaire des données sur les utilisateurs.
 */
public interface UserDao {

	/**
	 * Récupère un utilisateur depuis ses identifiants.
	 * 
	 * @param mail
	 *            adresse mail de l'utilisateur.
	 * @param password
	 *            mot de passe de l'utilisateur.
	 * 
	 * @return utilisateur correspondant aux identifiants.
	 * 
	 * @throws DaoException
	 *             erreur technique.
	 */
	User getUserWithCredentials(String mail, String password)
			throws DaoException;

	/**
	 * Récupère un utilisateur à partir de son adresse email.
	 * 
	 * @param userEmail
	 *            adresse email de l'utilisateur recherché.
	 * @return utilisateur correspondant à l'adresse email.
	 * 
	 * @throws DaoException
	 *             erreur technique.
	 */
	User getUserByEmail(String userEmail) throws DaoException;

	/**
	 * Vérifie si l'adresse email est déjà utilisée par un utilisateur.
	 * 
	 * @param mail
	 *            adresse email évaluée.
	 * @return <tt>true</tt> si l'adresse est utilisée, <tt>false</tt> sinon.
	 * 
	 * @throws DaoException
	 *             erreur technique.
	 */
	boolean isEmailAddressAlreadyUsed(String mail) throws DaoException;

	/**
	 * Création d'un nouveau compte utilisateur.
	 * 
	 * @param mail
	 *            adresse email de l'utilisateur.
	 * @param password
	 *            mot de passe de l'utilisateur.
	 * 
	 * @return utilisateur correspondant au nouveau compte créé.
	 * 
	 * @throws DaoException
	 *             erreur technique.
	 */
	User createUserAccount(String mail, String password) throws DaoException;

	/**
	 * Mise à jour du mot de passe de l'utilisateur. L'ancien mot de passe sera
	 * écrasé suite à cette opération.
	 * 
	 * @param user
	 *            compte utilisateur concerné.
	 * @param password
	 *            nouvelle valeur du mot de passe.
	 * 
	 * @throws DaoException
	 *             erreur technique.
	 */
	void updateUserPassword(User user, String password) throws DaoException;

}
